-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ticket14 docs webpage #31
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e code in docstrings formatted, add docs on how to use code blocks
… sphinx running doc
Update link to Admonition
davidkeymer
approved these changes
Sep 30, 2024
Tom-Willemsen
approved these changes
Sep 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #14
unfortunately this won't publish to pages until it's merged as it uses https://github.com/ISISComputingGroup/reusable-workflows/blob/main/.github/workflows/sphinx.yml which is pinned to only publish on main, but you can build the sphinx docs locally (see the page in
doc\dev\set_up_dev_environment.md
) and check they look OK as a reviewer.I played around with this and an old version of the docs has been published to https://isiscomputinggroup.github.io/ibex_bluesky_core/ as a proof of concept. the github workflow will run when merged and update (though give it a few minutes as it takes a while to publish to the webpage)
What this means for WIP/unreviewed branches:
doc/
folder structure has changed and adjust accordinglydoc/